Skip to content

Point the install steps at the latest stable release - #48

Merged
dmccoystephenson merged 2 commits into
mainfrom
feature/install-stable-release-link
Nov 20, 2026
Merged

dmccoystephenson merged 2 commits into
mainfrom
feature/install-stable-release-link

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

  • Step 1 of First Time Installation in README.md and of Installation in USER_GUIDE.md now links https://github.com/Dans-Plugins/FlyCommand/releases/latest, which GitHub resolves to the most recent release that is not a prerelease. Both steps previously said "the latest jar" from the releases page.
  • Each step also says that the "Development build" prerelease is not a stable release. The user guide's wording is taken from that build's own release notes in .github/workflows/dev-release.yml ("unreleased, unreviewed code that has not been through any release check").
  • CHANGELOG.md has a new ### Fixed bullet under [Unreleased].

Why: dev-release.yml deletes and re-creates the dev prerelease on every code push to main. That keeps it newer than v1.0.0, so it is listed first on the releases page and its jar was the first one a reader found by following the old step.

Closes #47

Validation

  • mvn -o clean package ran on the branch and all 13 tests passed: DocumentationTest 3, FlyCommandTest 4, PluginManifestTest 6, with no failures or errors. DocumentationTest still finds exactly one "currently …" version list in each guide, and it matches minecraft-versions.json.
  • git ls-remote --tags origin shows only dev and v1.0.0, so /releases/latest currently resolves to v1.0.0.
  • The #releases anchor used in the README points to the existing ### Releases heading in the same file.
  • No source, manifest or workflow file is touched, so the change has no effect on the plugin or how it is built.

Deferred issues

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

dmccoystephenson and others added 2 commits November 20, 2026 03:59
The releases page lists the rolling dev prerelease first, so "download
the latest jar from the releases page" led readers to the unreviewed
development build. Link /releases/latest instead, which GitHub resolves
to the newest non-prerelease release.

Closes #47

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A stable release published after the last dev push is listed above it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric, run against head 36e142f:

  • Scope: PASS. 3 files and +3/−2 lines (git diff --stat origin/main...HEAD). Each line is the install step that Install steps send readers to a releases page whose first jar is the dev prerelease #47 names, or that step's changelog bullet.
  • Validation-new: PASS. mvn -o clean package passed on the branch with 13 tests and 0 failures. DocumentationTest still finds exactly one version list in each guide. The README's #releases anchor points to the existing ### Releases heading. git ls-remote --tags origin shows only dev and v1.0.0, so /releases/latest resolves to v1.0.0.
  • Validation-fix: not applicable. The change is a documentation wording fix. No code behaviour is involved.
  • Sibling structure: PASS. No new files. The numbered install lists in both guides keep their three steps.
  • Sibling renames: not applicable.
  • Docs: PASS. README.md and USER_GUIDE.md are the only docs with download steps. COMMANDS.md, CONFIG.md and CONTRIBUTING.md do not mention downloading a release. CHANGELOG.md gains a ### Fixed bullet under [Unreleased].
  • Issue resolution: PASS. Both install steps named in Install steps send readers to a releases page whose first jar is the dev prerelease #47 now link /releases/latest and say the "Development build" prerelease is not a stable release.
  • CI: PASS. Build run 44723893266 on 36e142f succeeded, covering mvn clean package and the Bukkit API check against every version in minecraft-versions.json.
  • No harness leakage: PASS. git diff --name-only origin/main...HEAD lists only CHANGELOG.md, README.md and USER_GUIDE.md.

Finding fixed in 36e142f: README.md:18 and USER_GUIDE.md:9 originally said the dev prerelease is "at the top of" the releases page. That stops being true for a while after each stable release is published, because the stable release is newer until the next dev push. The wording is now "on the releases page".

Do-not-auto-merge paths: none touched. No workflow, src/, plugin.yml, .github/copilot-instructions.md or LICENSE changes, and no single file has more than 50 lines deleted.

This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 180dba7 into main Nov 20, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the feature/install-stable-release-link branch November 20, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install steps send readers to a releases page whose first jar is the dev prerelease

1 participant